<!--$Id: mt.so,v 10.48 2005/07/20 16:34:05 bostic Exp $-->
<!--Copyright (c) 1997,2008 Oracle.  All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB Reference Guide: Multithreaded applications</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<a name="2"><!--meow--></a>
<table width="100%"><tr valign=top>
<td><b><dl><dt>Berkeley DB Reference Guide:<dd>Programmer Notes</dl></b></td>
<td align=right><a href="../program/environ.html"><img src="../../images/prev.gif" alt="Prev"></a><a href="../toc.html"><img src="../../images/ref.gif" alt="Ref"></a><a href="../program/scope.html"><img src="../../images/next.gif" alt="Next"></a>
</td></tr></table>
<p align=center><b>Multithreaded applications</b></p>
<p>Berkeley DB fully supports multithreaded applications.  The Berkeley DB library is
not itself multithreaded, and was deliberately architected to not use
threads internally because of the portability problems that would
introduce.  Database environment and database object handles returned
from Berkeley DB library functions are free-threaded.  No other object handles
returned from the Berkeley DB library are free-threaded.  The following rules
should be observed when using threads to access the Berkeley DB library:</p>
<ol>
<p><li>The <a href="../../api_c/env_open.html#DB_THREAD">DB_THREAD</a> flag must be specified to the <a href="../../api_c/env_open.html">DB_ENV-&gt;open</a>
and <a href="../../api_c/db_open.html">DB-&gt;open</a> methods if the Berkeley DB handles returned by those interfaces
will be used in the context of more than one thread.  Setting the
<a href="../../api_c/env_open.html#DB_THREAD">DB_THREAD</a> flag inconsistently may result in database corruption.
<p>Threading is assumed in the Java API, so no special flags are required;
and Berkeley DB functions will always behave as if the <a href="../../api_c/env_open.html#DB_THREAD">DB_THREAD</a> flag
was specified.</p>
<p>Only a single thread may call the <a href="../../api_c/env_close.html">DB_ENV-&gt;close</a> or <a href="../../api_c/db_close.html">DB-&gt;close</a> methods
for a returned environment or database handle.</p>
<p>No other Berkeley DB handles are free-threaded.</p>
<p><li>When using the non-cursor Berkeley DB calls to retrieve key/data items (for
example, <a href="../../api_c/db_get.html">DB-&gt;get</a>), the memory to which the pointer stored into
the Dbt refers is valid only until the next call using the <a href="../../api_c/db_class.html">DB</a>
handle returned by <a href="../../api_c/db_open.html">DB-&gt;open</a>.  This includes <b>any</b> use of
the returned <a href="../../api_c/db_class.html">DB</a> handle, including by another thread within the
process.
<p>For this reason, if the <a href="../../api_c/env_open.html#DB_THREAD">DB_THREAD</a> handle was specified to the
<a href="../../api_c/db_open.html">DB-&gt;open</a> method, either <a href="../../api_c/dbt_class.html#DB_DBT_MALLOC">DB_DBT_MALLOC</a>, <a href="../../api_c/dbt_class.html#DB_DBT_REALLOC">DB_DBT_REALLOC</a>,
or <a href="../../api_c/dbt_class.html#DB_DBT_USERMEM">DB_DBT_USERMEM</a> must be specified in the <a href="../../api_c/dbt_class.html">DBT</a> when
performing any non-cursor key or data retrieval.</p>
<p><li>Cursors may not span transactions.  Each cursor must be
allocated and deallocated within the same transaction.
<p>Transactions and cursors may span threads, but only serially, that is,
the application must serialize access to the <a href="../../api_c/txn_class.html">DB_TXN</a> and
<a href="../../api_c/dbc_class.html">DBC</a> handles.  In the case of nested transactions, since all
child transactions are part of the same parent transaction, they must observe
the same constraints.  That is, children may execute in different threads
only if each child executes serially.</p>
<p><li>User-level synchronization mutexes must have been implemented for the
compiler/architecture combination.  Attempting to specify the DB_THREAD
flag will fail if fast mutexes are not available.
<p>If blocking mutexes are available (for example POSIX pthreads), they
will be used.  Otherwise, the Berkeley DB library will make a system call to
pause for some amount of time when it is necessary to wait on a lock.
This may not be optimal, especially in a thread-only environment, in
which it is usually more efficient to explicitly yield the processor to
another thread.</p>
<p>It is possible to specify a yield function on an per-application basis.
See <a href="../../api_c/set_func_yield.html">db_env_set_func_yield</a> for more information.</p>
<p>It is possible to specify the number of attempts that will be made to
acquire the mutex before waiting.  See <a href="../../api_c/mutex_set_tas_spins.html">DB_ENV-&gt;mutex_set_tas_spins</a> for
more information.</p>
</ol>
<p>When creating multiple databases in a single physical file, multithreaded
programs may have additional requirements.  For more information, see
<a href="../../ref/am/opensub.html">Opening multiple databases in a single
file.</a></p>
<table width="100%"><tr><td><br></td><td align=right><a href="../program/environ.html"><img src="../../images/prev.gif" alt="Prev"></a><a href="../toc.html"><img src="../../images/ref.gif" alt="Ref"></a><a href="../program/scope.html"><img src="../../images/next.gif" alt="Next"></a>
</td></tr></table>
<p><font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
</body>
</html>
